home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir39 / ee1.zip / EE.DOC next >
Text File  |  1994-01-01  |  13KB  |  267 lines
  1. DISCLAIMER -
  2.  
  3. This program is provided "as is", with no expressed or implied warranty for
  4. suitability to a particular purpose. While every effort has been made to
  5. assure it will function properly, the user assumes all risk, and the authors
  6. and distributors will not be liable for any loss due to the use of the
  7. program. No promise is made to support this program, or to update it in any
  8. future release.
  9.  
  10. DISTRIBUTION -
  11.  
  12. This program is distributed as freeware. As such, the author retains
  13. copyright on the program and all materials distributed with it, and no person
  14. or persons may sell or distribute all or part of the package without the the
  15. author's express written permission. Permission is given to distribute this
  16. program intact, unaltered and with all associated materials. This program may
  17. NOT be sold, regardless of profitable intent.
  18.  
  19. DESCRIPTION -
  20.  
  21. EE is an environment editor. It allows the user to edit the entries in the
  22. active environment, changing things like search path, command interpreter
  23. specification, TEMP and/or TMP directory settings and any other assignments
  24. in the table. EE supports the use of a mouse, cut and paste operations, write
  25. to or read from a file, search and replace and many other functions.
  26.  
  27. OPERATION -
  28.  
  29. EE has no command line parameters. When started, EE searches for and locates
  30. the master environment table. It converts the table into editable text, and
  31. displays it in a text window which can be resized and moved with the mouse.
  32. Each entry is terminated with a large dot. EE supports the following
  33. functions:
  34.  
  35. ESC   -
  36. ALT-X - Exit; leave EE. EE will ask if you wish to update the environment
  37.     with the displayed information. Use the "Y" or "N" keys to select an
  38.     answer, or press the space bar to toggle. If you select "Yes" and the
  39.     displayed environment exceeds the maximum space available in the
  40.     table, EE will beep and refuse to exit. The program may still be
  41.     terminated by selecting "No". EE will remove all leading and trailing
  42.     blanks and blank lines from the edited environment before updating
  43.     the master table.
  44.  
  45. ALT-M - Toggle marking mode; turn the highlight on or off. See also the OTHER 
  46.     KEYS and MOUSE FUNCTIONS sections below.
  47.  
  48. ALT-U - Cut; removes the marked region from the environment, moving the text
  49.     into the cut buffer. Stops marking mode.
  50.  
  51. ALT-O - Copy; moves the marked region into the cut buffer, but does not
  52.     remove it from the environment.
  53.  
  54. INS   - Paste; moves the contents of the cut buffer into the environment at
  55.     the location of the cursor.
  56.  
  57. DEL   - Delete; if the anchor is set, removes the marked region from the
  58.     environment, but does not move the text into the cut buffer. If the
  59.     anchor is not set, deletes the character at the current cursor
  60.     location.
  61.  
  62. CTL-Y - Delete line; removes the line where the cursor is currently 
  63.     positioned. The cut line is placed in the cut buffer, and can be
  64.     pasted with the INSert key.
  65.  
  66. ALT-H - Help; pops up a small help window which contains a command synopsis.
  67.     Selecting a command from this window causes it to execute. Commands
  68.     can be selected with the mouse or the Enter key.
  69.  
  70. ALT-L - Load; loads the environment from a file. The current contents of the
  71.     environment are replaced by the file contents. Files must be in a
  72.     format consistent with that created by the Write function (ALT-W).
  73.  
  74. ALT-W - Write; writes the environment to a file. The current contents of the
  75.     environment are not changed. Files are written with carriage return/
  76.     line feed terminators separating each entry.
  77.  
  78. ALT-S - Search; searches for the specified string. Searches forward through
  79.     the environment from the current cursor location, and places the
  80.     cursor at the beginning of the first occurence of the search string.
  81.  
  82. ALT-R - Replace; replaces the search string with the replacement string.
  83.     Searches forward through the environment from the current cursor
  84.     location. When the first occurence is located, EE will place the
  85.     "Replace? Yes, No, Global : " prompt in the window border. Pressing
  86.     "Y" will replace the string, "N" will skip the occurence, and "G"
  87.     will cause al further occurences to be replaced without prompting.
  88.     The function will search through the end of the environment.
  89.  
  90. OTHER KEYS -
  91.  
  92. The left and right arrow keys move the cursor to the left or right one
  93. character. The up and down arrow keys move the cursor up and down one line.
  94. The HOME key moves to the beginning of the current line, and the END key
  95. moves to the end of the current line. The PgUp and PgDn keys move up and down
  96. one entire page of text. The Num Lock key will toggle the marking mode when
  97. using these keys from the key pad.
  98.  
  99. The Backspace key removes the character immediately preceeding the cursor.
  100. The Ctrl-HOME and Ctrl-END keys move to the top and bottom of the environment. 
  101. The Enter key inserts a carriage return into the environment at the current
  102. cursor location. Tabs, of course, are illegal.
  103.  
  104. MOUSE FUNCTIONS -
  105.  
  106. When clicked inside the window, the left mouse button moves the cursor (and,
  107. if marking mode is on, the highlight) to the current mouse location. The
  108. cursor will not move outside the displayed text. If clicked and held on the
  109. border corners, the window can be resized. If clicked and held on the border
  110. anywhere else, the window can be moved. EE maintains the original DOS screen
  111. below the window.
  112.  
  113. The right mouse key performs the same function as Alt-M, i.e., toggles
  114. marking mode, but it moves the cursor to the mouse location before doing so.
  115.  
  116. SCROLLING -
  117.  
  118. The window will scroll automatically to the left or right with the cursor to
  119. display entries greater than 78 characters in length. The window may be 
  120. scrolled up and down by clicking on the scroll lights at either end of the 
  121. scroll bar in the right hand edge of the border, or with the PgUp and PgDn 
  122. keys. Typically, the environment table can be displayed in a single screen. 
  123. If there is no additional information to be displayed, the scroll lights will 
  124. not appear.
  125.  
  126. MAXIMUM ENVIRONMENT SIZE -
  127.  
  128. When not in search mode, EE displays the current and maximum number of
  129. characters in the environment in the lower, left-hand corner of the window
  130. border. EE will not exit with the ALT-X key if the current number of
  131. characters in the environment exceeds the maximum allowed. (The program may
  132. still be terminated by selecting "No" when asked if the environment should be
  133. updated.) Blank lines and leading or trailing spaces do not count against the
  134. final total, though EE does include them in the count displayed in the
  135. border. Remove all blank lines and leading or trailing spaces in the
  136. environment to get an acurrate count and to determine if EE can update the
  137. master environment table.
  138.  
  139. Do to some overhead in storing the table the count is actually one greater
  140. than the actual number of characters, and entry terminators count, too.
  141.  
  142. EE will allow the addition of text to a value twice the maximum size of the
  143. master environment, up to 64k. This additional room is provided for editing
  144. puroses only, and EE will not expand the size of the master environment table
  145. to accomdate this additional information.
  146.  
  147. OPERATION IN A MICROSOFT WINDOWS DOS SESSION -
  148.  
  149. When run in a DOS session under Windows, EE will edit the master environment
  150. table for that session only. This allows multiple DOS sessions to have unique
  151. environments. If you experience trouble while running EE in a Windows DOS
  152. session under 386Enh mode, set the "UniqueDOSPSP" parameter in the SYSTEM.INI
  153. file to "TRUE", and restart Windows. EE cannot edit the master environment in
  154. use by Windows itself, unless it is used before Windows is started.
  155.  
  156. OPERATION IN A DOS SHELL SESSION -
  157.  
  158. Some programs allow the user to load an additional instance of the command
  159. interpreter and transfer control there for DOS operations without unloading
  160. the program. Others transfer control back to the original instance of the
  161. command interpreter to provide this service. In the first type, any changes
  162. to the environment will be lost when the command interpreter is EXITed and
  163. control returns to the "shelling" program. In the second type, changes made
  164. to the environment with EE will be present in the environment table used by
  165. the program and may cause erratic behavour and data lost. Caution should be
  166. used when altering the environment with EE in a DOS shell created by an
  167. application program.
  168.  
  169. THE COMSPEC ENTRY -
  170.  
  171. The COMSPEC entry in the environment is created by DOS during the boot
  172. process. Removing or altering the value of this variable can cause erratic
  173. behavour or system lock-up. In general, this entry should not be altered or
  174. removed. Specifically, you should not change the value to point to a location
  175. where a copy of the command interpreter cannot be found.
  176.  
  177. THE PROMPT ENTRY -
  178.  
  179. Changes to the PROMPT entry will take effect immediately upon EE's
  180. termination. Caution should be used in modifying this value, as erroneous
  181. values can cause system lock-up. Consult the DOS Manual for valid forms of
  182. this entry.
  183.  
  184. PATH AND OTHER DIRECTORY SPECIFYING ENTRIES -
  185.  
  186. Modification of entries in the environment which specify locations on disk
  187. such as the PATH variable, will take effect immediately on EE's termination.
  188. If DOS or application programs are unable to successfully parse the modified
  189. entries, erratic behaviour, data loss and system lock-up may result.
  190.  
  191. DOS VERSIONS SUPPORTED -
  192.  
  193. PC- and MS-DOS versions 2.0 and later, up to MS-DOS 6.2, including IBM-DOS
  194. 5.0 and 5.02. EE should also work on other versions of DOS which support a
  195. master environment, such as DR-DOS and 4DOS, though this has not been tested. 
  196. Window DOS sessions have been tested under Windows 3.0 and 3.1 in both 
  197. standard and enhanced modes, with PC-DOS 3.3 and IBM-DOS 5.0 and 5.02. EE 
  198. should function properly in all versions of Windows from version 2.0 and in 
  199. all modes.
  200.  
  201. EE does not use any DOS stacks, and has been successfully tested when 
  202. STACKS=0,0.
  203.  
  204. OTHER CONSIDERATIONS -
  205.  
  206. EE has been tested successfully with programs that move the master
  207. environment table into a UMB. EE has NOT been tested with Desqview,
  208. Desqview/X or OS/2 DOS services. EE has been tested in the presence of IBM PC
  209. LAN versions 1.2 and 1.3, Banyan VINES versions 4.10 through 4.11(5) and
  210. Novell Netware shells from version 3.02 to 3.21. EE can successfully edit the 
  211. environment of the Novell Netware non-dedicated DOS process on a version 2.2 
  212. server.
  213.  
  214. EE is a large program, and requires at least 160K of conventional memory to
  215. execute. If the user has extended the size of the standard environment beyond 
  216. the default size, EE will require slightly more memory. If the memory pool is 
  217. exausted while EE is executing, it will restore the original environment and 
  218. terminate. EE does not use EMS, XMS or UMB memory, nor does it create 
  219. temporary scratch files on disk.
  220.  
  221. EE has been successfully tested on 8088, 8086, NEC V-20, 80286, 80386 and
  222. 80486 processors, both 83 and 101 key keyboards, and with CGA, EGA, VGA and
  223. SVGA (up to 1024x768) video types. EE will only enable mouse operations if it
  224. detects a Microsoft compatible mouse.
  225.  
  226. PLANNED ENHANCEMENTS -
  227.  
  228. Future versions of EE may include some or all of the following enhancements:
  229.  
  230. * Access to environment tables other than that of the current instance of
  231.   the command interpreter.
  232.  
  233. * The ability to alter the maximum size of the environment table.
  234.  
  235. * Syntacic checking of environment entries upon demand and/or program exit.
  236.  
  237. * Programmable mouse functions.
  238.  
  239. * Support for color and graphics operation.
  240.  
  241. * Optional AUTOEXEC.BAT file update/modification.
  242.  
  243. * Extended help.
  244.  
  245. CONTACTING THE AUTHOR -
  246.  
  247. The author has found EE to be useful and powerful, though its tough to get
  248. used to the idea of altering your environment without a reboot. Even though
  249. future updates, releases, "bug fixes" and support are not promised with EE,
  250. the author would still very much like to hear your impressions on the
  251. strength and/or shortcomings of the program, and any ideas you might have
  252. for additional features beyond those listed above. The author can be reached
  253. at the following E-Mail addresses:
  254.  
  255. Compuserve: 70751,3127
  256. BIX:        mfisher
  257.  
  258. Compuserve is the preferred method of contact, the author checks his E-Mail
  259. on that system daily. Remember, no support is promised, and no warranty or
  260. guarantee is extended; users assume all risks.
  261.  
  262. THANKS -
  263.  
  264. to the Microsoft Systems Journal, who, after a two year drought, finally
  265. published something the author of EE found of use. Thanks also to Paul Reid
  266. for his help and suggestions.
  267.